Merged
Conversation
Add Failure Issue Reporting (report-failure-as-issue:) term introduced in PR #20266. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
bot
added
documentation
pelikhan
approved these changes
Mar 10, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the documentation glossary with a new safe-outputs term describing how to control automatic failure issue creation.
Changes:
- Add a glossary entry for Failure Issue Reporting (
report-failure-as-issue:) with a brief description and YAML example. - Link the new term to the Safe Outputs reference for additional details.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
|
||
| ### Failure Issue Reporting (`report-failure-as-issue:`) | ||
|
|
||
| A `safe-outputs` option controlling whether workflow run failures are automatically reported as GitHub issues. Defaults to `true` when safe outputs are configured. Set to `false` to suppress failure issue creation for workflows where failures are expected or handled externally: |
There was a problem hiding this comment.
The default is described as "Defaults to true when safe outputs are configured", but the option itself is simply a boolean with default true (and only applies when safe-outputs is present). Consider rephrasing to match the Safe Outputs reference/schema wording (e.g., "default: true") to avoid implying the default changes based on whether safe outputs are configured.
Suggested change
| A `safe-outputs` option controlling whether workflow run failures are automatically reported as GitHub issues. Defaults to `true` when safe outputs are configured. Set to `false` to suppress failure issue creation for workflows where failures are expected or handled externally: | |
| A `safe-outputs` option controlling whether workflow run failures are automatically reported as GitHub issues (default: `true`). Set to `false` to suppress failure issue creation for workflows where failures are expected or handled externally: |
This was referenced Mar 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Glossary Updates - 2026-03-10
Scan Type
Terms Added
report-failure-as-issue:): Newsafe-outputsoption from PR Improve failure issue actionability with generic debug prompt and report-failure-as-issue option #20266 that controls whether workflow run failures are automatically reported as GitHub issues. Defaults totrue; set tofalseto suppress failure issue creation.Terms Updated
None
Changes Analyzed
report-failure-as-issue:option insafe-outputsRelated Changes
report-failure-as-issueoptionmax-patch-sizemissing fromtools.repo-memoryJSON schema #20309: Fixmax-patch-sizemissing fromtools.repo-memoryJSON schema (already documented in repo-memory reference, no new glossary term needed)Notes
Other changes were internal refactoring (safe_outputs_generation.go split), bug fixes, and CLI flag additions not requiring glossary updates.